Recognize an existing Data Model

{ recognizeModel }

Recognizes an existing model from a third party engine.

Method

/API3/dataSources/recognizeModel

  • API Section: /API3/dataSources
  • API Version: 3.0
  • From Release: 2023.10
  • Can be used by all user types
  • REST API and Client SDK libraries. REST APIs via POST actions only.
  • Input Parameters

    Name

    modelRecognitionObject

    Object Type

    Description

    The model and its details.

    Output Response

    Successful Result Code

    200

    Response Type

    Description of Response Type

    Generic API response object with success or failure flag and related messages.

    Notes

    Use this method to add an existing model into Pyramid. This specifically includes models like MS OLAP cubes, Tabular models, SAP Hana Views and SAP BW Infocubes Once recognized, the models can be used for other operations like the data source changer.

    Code Snippets

    JavaScript
    Curl
    Java
    C#
    Python
    PHP
    curl -X POST \
    -H "paToken: [[apiKey]]" \
     -H "Accept: application/json" \
     -H "Content-Type: application/json" \
     "http://Your.Server.URL/API3/dataSources/recognizeModel" \
     -d '{
      "modelName" : "modelName",
      "isDynamicModel" : true,
      "databaseName" : "databaseName",
      "serverId" : "serverId"
    }'
    
    import com.pyramidanalytics.*;
    import com.pyramidanalytics.auth.*;
    import com.pyramidanalytics.model.*;
    import com.pyramidanalytics.api.DataSourcesServiceApi;
    
    import java.util.*;
    
    public class DataSourcesServiceApiExample {
        public static void main(String[] args) {
            ApiClient defaultClient = Configuration.getDefaultApiClient();
            defaultClient.setBasePath("http://Your.Server.URL/");
            
            // Configure API key authorization: paToken
            ApiKeyAuth paToken = (ApiKeyAuth) defaultClient.getAuthentication("paToken");
            paToken.setApiKey("YOUR API KEY");
            // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
            //paToken.setApiKeyPrefix("Token");
    
            // Create an instance of the API class
            DataSourcesServiceApi apiInstance = new DataSourcesServiceApi();
            // Initialize the modelRecognitionObject parameter object for the call
            ModelRecognitionObject modelRecognitionObject = ; // ModelRecognitionObject | 
    
            try {
                ModifiedItemsResult result = apiInstance.recognizeModel(modelRecognitionObject);
                System.out.println(result);
            } catch (ApiException e) {
                System.err.println("Exception when calling DataSourcesServiceApi#recognizeModel");
                e.printStackTrace();
            }
        }
    }
    
    const PyramidAnalyticsWebApi = require('pyramid_analytics_web_api');
    const defaultClient = PyramidAnalyticsWebApi.ApiClient.instance;
    
    // Configure API key authorization: paToken
    const paToken = defaultClient.authentications['paToken'];
    paToken.apiKey = "YOUR API KEY";
    // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    //paToken.apiKeyPrefix['paToken'] = "Token";
    
    // Create an instance of the API class
    const api = new PyramidAnalyticsWebApi.DataSourcesServiceApi("http://Your.Server.URL")
    const modelRecognitionObject = ; // {ModelRecognitionObject} 
    
    const callback = function(error, data, response) {
      if (error) {
        console.error(error);
      } else {
        console.log('API called successfully. Returned data: ' + data);
      }
    };
    api.recognizeModel(modelRecognitionObject, callback);
    
    using System;
    using System.Diagnostics;
    using PyramidAnalytics.Sdk.Api;
    using PyramidAnalytics.Sdk.Client;
    using PyramidAnalytics.Sdk.Model;
    
    public class recognizeModelExample
    {
        public static void Main()
        {
            Configuration conf = new Configuration();
            conf.BasePath = "http://Your.Server.URL/";
            
            // Configure API key authorization: paToken
            conf.ApiKey.Add("paToken", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // conf.ApiKeyPrefix.Add("paToken", "Bearer");
    
            GlobalConfiguration.Instance = conf;
            
            // Create an instance of the API class
            var apiInstance = new DataSourcesServiceApi();
            // Initialize the modelRecognitionObject parameter object for the call
            var modelRecognitionObject = new ModelRecognitionObject(); // ModelRecognitionObject | 
    
            try {
                // Recognizes an existing model from a third party engine.
                ModifiedItemsResult result = apiInstance.recognizeModel(modelRecognitionObject);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling DataSourcesServiceApi.recognizeModel: " + e.Message );
            }
        }
    }
    
    
    import com.pyramidanalytics
    from com.pyramidanalytics import ApiException
    from pprint import pprint
    
    
    # Configure API key authorization: paToken
    api_config = com.pyramidanalytics.Configuration(host = 'http://Your.Server.URL/', api_key={ paToken:'YOUR_ACCESS_TOKEN' })
    # Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
    # api_config.api_key_prefix['paToken'] = 'Bearer'
    
    with com.pyramidanalytics.ApiClient(api_config) as api_client:
        # Create an instance of the API class
        api_instance = com.pyramidanalytics.DataSourcesServiceApi(api_client)
        # Initialize the modelRecognitionObject parameter object for the call
        modelRecognitionObject =  # ModelRecognitionObject | 
    
        try:
            # Recognizes an existing model from a third party engine.
            api_response = api_instance.recognize_model(modelRecognitionObject)
            pprint(api_response)
        except ApiException as e:
            print("Exception when calling DataSourcesServiceApi->recognizeModel: %s\n" % e)
    <?php
    require_once(__DIR__ . '/vendor/autoload.php');
    
    OpenAPITools\Client\Configuration::getDefaultConfiguration()->setHost('http://Your.Server.URL');
    
    // Configure API key authorization: paToken
    OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKey('paToken', 'YOUR_API_KEY');
    // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
    // OpenAPITools\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('paToken', 'Bearer');
    
    // Create an instance of the API class
    $api_instance = new OpenAPITools\Client\Api\DataSourcesServiceApi();
    $modelRecognitionObject = ; // ModelRecognitionObject | 
    
    try {
        $result = $api_instance->recognizeModel($modelRecognitionObject);
        print_r($result);
    } catch (Exception $e) {
        echo 'Exception when calling DataSourcesServiceApi->recognizeModel: ', $e->getMessage(), PHP_EOL;
    }
    ?>

    Note: Use the 'Authentication' API methods to generate an access 'key' or 'token'.